Skip to content

System tests components.yaml: Fix description for various arguments#777

Merged
MakisH merged 1 commit into
developfrom
components-description
May 12, 2026
Merged

System tests components.yaml: Fix description for various arguments#777
MakisH merged 1 commit into
developfrom
components-description

Conversation

@MakisH

@MakisH MakisH commented May 12, 2026

Copy link
Copy Markdown
Member

There is currently a recurrent typo in the components.yaml: a semnantic: that should be description:.

Still, I am wondering whether this is actually used at the moment. I see a reference in https://github.com/precice/tutorials/blob/develop/tools/tests/metadata_parser/metdata.py, but I have not looked closer.

@PranjalManhgaye what do you think?

@MakisH MakisH self-assigned this May 12, 2026
@PranjalManhgaye

Copy link
Copy Markdown
Collaborator

@MakisH i checked this quickly , the parser does read the " description" key in BuildArguments.from_components_yaml(), and if it is missing it falls back to No description provided for <argument_name> , So I think this typo does not affect the actual systemtest runs, since the argument names and defaults are still parsed. But we do lose the intended description metadata, so this cleanup still makes sense to me.

@MakisH

MakisH commented May 12, 2026

Copy link
Copy Markdown
Member Author

Thanks! Then I am merging this, we can revisit the "what to actually do with this" later.

@MakisH MakisH merged commit b962067 into develop May 12, 2026
3 checks passed
@MakisH MakisH deleted the components-description branch May 12, 2026 11:36
mike-tree-corvid pushed a commit to mike-tree-corvid/tutorials that referenced this pull request Jun 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants